GetIndexedCollectionItemHdl

GetIndexedCollectionItemHdl
Header:	Collections.h		Carbon status:	Supported

Copies the variable-length data associated with a collection item into a Macintosh Memory Manager handle, given the item’s collection index.

OSErr GetIndexedCollectionItemHdl (
    Collection aCollection, 
    SInt32 index, 
    Handle itemData
);

aCollection: A reference to the collection object containing the item whose data you want to retrieve. The behavior of this function is undefined if you do not provide a reference to a valid collection object.
index: The collection index associated with the item whose data you want to retrieve.
itemData: A handle to a block of memory to contain the item’s data. On return, this memory contains a copy of the data associated with the specified item.

function result: A result code.

DISCUSSION

To retrieve the data associated with a collection item into a block of memory referenced by a pointer (rather than a handle), use the GetCollectionItem function.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.